Information provided by MP to Client
Information provided by MP to Client
- application/json
Request Body required
Optional description in Markdown
productionForecastResponse object required
The concrete information about a production forecast
listOfForecastItems object[] required
List of ForecastItems matching the items to an order
positionId string requiredIdentifier of a position of an order
productionForecast string requiredPossible values: Value must match regular expression
-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
Date of completion
precisionOfForecast object required
Accuracy of the prediction
timeUnit string requiredPossible values: Value must match regular expression
[a-zA-Z]*:[a-zA-Z]+
, [unit:secondUnitOfTime
,unit:minuteUnitOfTime
,unit:hour
,unit:day
,unit:week
,unit:month
,unit:year
]Specifies the unit in which the time is represented
value number requiredThe amount of timeUnits considered
productionStatus string requiredPossible values: [
itemReceived
,itemPlanned
,itemInProduction
,itemCompleted
,statusUndefined
]Status of the order/position within MP
reasonsForDelay stringPossible values: [
supplyProblems
,otherCircumstances
,internalProblems
,noInformationAvailable
]Optional field to provide information to the customer why a delivery date is not met
returnCode string requiredPossible values: [
ok
,lowerAccuracyOfPrecision
,noForecastAvailable
]Return code that indicates whether a single item of an order matches the customers desired request
forecastDate string requiredPossible values: Value must match regular expression
-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
Date/time of the forecast calculation
iterationNumber numberOnly set in CommunicationMode == "notification/cyclic" to be able to check the order of the notifications.
Not required for communication mode = "synchronous"
communicationMode string requiredPossible values: [
synchronous
,cyclic
,notification
]Specification of the communication mode
versionDataModel string requiredSpecifies the used version of the data model
header object required
Contains information common to all messages
messageId string requiredUnique ID identifying the message. The purpose of the ID is to uniquely identify a single message, therefore it MUST not be reused.
context string requiredInformation about the context the message should be considered in. Default: For Use Cases which need to validate against the Semantic Hub automatically. Fallback: For Use Cases which do not use automatic validation. In both cases: Versioning only refers to major versions. String pattern of the value follows:
- - sentDateTime string requiredPossible values: Value must match regular expression
-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
Time zone aware timestamp holding the date and the time the message was sent by the sending party. The value MUST be formatted according to the ISO 8601 standard
senderBpn string requiredThe Business Partner Number of the sending party. The value MUST be a valid BPN. BPNA and BPNS are not allowed. Applicable constraints are defined in the corresponding standard
receiverBpn string requiredThe Business Partner Number of the receiving party. The value MUST be a valid BPN. BPNA and BPNS are not allowed. Applicable constraints are defined in the corresponding standard.
expectedResponseBy stringPossible values: Value must match regular expression
-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
Time zone aware timestamp holding the date and time by which the sending party expects a certain type of response from the receiving party. The meaning and interpretation of the fields's value are context-bound and MUST therefore be defined by any business domain or platform capability making use of it. The value MUST be formatted according to the ISO 8601 standard
relatedMessageId stringUnique ID identifying a message somehow related to the current one
version string requiredThe version of the standard defining the semantics and the structure of the message's header. The version number should follow the Semantic Versioning 2.0.0 specification.
- 200
- 400
- 401
- 403
- 420
- 421
OK. The request has succeeded
Bad request. The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
Unauthorized. Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
Forbidden. The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource.
lowerAccuracyOfPrecision. the returned data has a lower precision than requested
noForecastAvailable. No data available